Add documentation for ppl #15401
Merged
Add documentation for ppl #15401
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
wu-hui
force-pushed
the
wuandy/RealPpl_11
branch
from
972da3c to
a3e4b27
Compare
cherylEnkidu
changed the base branch from
wuandy/RealPpl_11
to
feat/pipeline/private-preview
wu-hui
reviewed
Oct 29, 2025
| /// } | ||
| /// ``` | ||
| /// | ||
| /// - Returns: A `PipelineSource` that can be used to build and execute a pipeline. |
There was a problem hiding this comment.
FWIW, I have updated Android's comment to this:
/**
- Creates a new {@link PipelineSource} to build and execute a data pipeline.
-
A pipeline is composed of a sequence of stages. Each stage processes the
- output from the previous one, and the final stage's output is the result of the
- pipeline's execution.
-
Example usage:
-
{@code - Pipeline pipeline = firestore.pipeline()
- .collection("books")
- .where(Field("rating").isGreaterThan(4.5))
- .sort(Field("rating").descending())
- .limit(2);
- }
-
Note on Execution: The stages are conceptual. The Firestore backend may
- optimize execution (e.g., reordering or merging stages) as long as the
- final result remains the same.
-
Important Limitations:
-
- Pipelines operate on a request/response basis only.
- They do not utilize or update the local SDK cache.
- They do not support realtime snapshot listeners.
- @return A {@code PipelineSource} to begin defining the pipeline's stages.
*/
| /// | ||
| /// - Parameter others: An array of at least one `Expression` value to check against. | ||
| /// - Returns: A new `BooleanExpr` representing the "NOT IN" comparison (not_eq_any). | ||
| /// - Returns: A `BooleanExpression` that can be used in `where` clauses. |
There was a problem hiding this comment.
can be used in a where stage, among others.
?
| /// the field to set or update. | ||
| /// - Parameter value: The `Expression` representing the value to set for the field. | ||
| /// - Returns: A new `FunctionExpression` representing the map with the updated field. | ||
| func mapSet(key: Expression, value: Sendable) -> FunctionExpression |
There was a problem hiding this comment.
already did In the next PR: #15457
| /// - Returns: A new "FunctionExpression" representing the bitwise AND operation. | ||
| func bitAnd(_ bitsExpression: Expression) -> FunctionExpression { | ||
| return FunctionExpression("bit_and", [self, bitsExpression]) | ||
| return FunctionExpression(functionName: "bit_and", args: [self, bitsExpression]) |
There was a problem hiding this comment.
bit* operations are not in scope.
There was a problem hiding this comment.
You can also delete the tests.
There was a problem hiding this comment.
All the APIs here are for internal access. I moved the function here instead of deleting it to reduce future rework.
| /// - Returns: A new `FunctionExpression` representing the Manhattan distance. | ||
| func manhattanDistance(_ expression: Expression) -> FunctionExpression { | ||
| return FunctionExpression("manhattan_distance", [self, expression]) | ||
| return FunctionExpression(functionName: "manhattan_distance", args: [self, expression]) |
There was a problem hiding this comment.
All the APIs here are for internal access. I moved the function here instead of deleting it to reduce future rework.
wu-hui
approved these changes
Oct 31, 2025
cherylEnkidu
merged commit 680503d
into
feat/pipeline/private-preview
25 of 26 checks passed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
#no-changelog